The Compressor Name Structure

The CodecNameSpec data type defines a compressor name structure.



 
/* compressor name structure from GetCodecNameList function */

struct CodecNameSpec 

{

    CodecComponent codec;       /* component ID for compressor */

    CodecType cType;            /* type identifier for compressor */

    Str31 typeName;             /* string identifier of algorithm */

    Handle name;                /* name of compressor component */

};

typedef struct CodecNameSpec CodecNameSpec;

codec: Uniquely identifies the component or, in some cases, contains a special value that selects all components. If your application requests a list of components, the codec field in each compressor name structure contains the component ID for that compressor. If your application requests a list of component types, the codec field is set to 0 in each compressor name structure.
cType: Contains the type identifier for the compressor. The value of this field indicates the compression algorithm supported by the component. See the description of GetCodecNameList on GetCodecNameList for a list of valid values.
typeName: Contains a text string in Pascal format that identifies the compression algorithm supported by the component. This string may be used to identify the compression algorithm to the user. The value of this field should correspond to the value of the typeName field in the appropriate compressor information structure returned by the component in response to a GetCodecInfo function (see "The Compressor Information Structure" for information on the compressor information structure; see GetCodecInfo for information on the GetCodecInfo function).
name: Specifies the name of the compressor component. Developers assign these names to uniquely identify their products. This name may be used to identify the component to the user.

Previous | Chapter Top | Chapter Contents | Next